home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 April / EnigmA AMIGA RUN 17 (1997)(G.R. Edizioni)(IT)[!][issue 1997-04][EAR-CD].iso / EARCD / util / pack / xpk_Source.lha / xpk_Source / AboutSources
Text File  |  1996-11-29  |  4KB  |  96 lines
  1.                        A small guide to the sources
  2.  
  3. IMPORTANT: As long as any of the authors are reachable via mail/e-mail
  4. contact them first, before you make somehow changed/patched versions.
  5.  
  6. Also the sources of main xpk library are offered, but this doesn't give
  7. you the right to create your own version of xpkmaster.library (it is not
  8. public domain software). Everytime you have to contact either Dirk Stöcker,
  9. Christian von Roques or Urban Dominik Müller. We may give you the OK to
  10. do further development!
  11.  
  12. ----------------------------------------------------------------------------
  13.  
  14. You should begin your tour to these sources in the examples directory, which
  15. contains some simple examples of how to write applications using xpk.
  16.  
  17. The directory Shell contains the sources of what I think are the basic shell
  18. utilities for xpk.
  19.  
  20. If you want to write a sublibrary in C, the best place to start with are
  21. the sources of xpkRLEN.library.
  22.  
  23. Assembler programmers should take a look at the sources of xpkFAST.library.
  24. I tried to separate the .library bureaucrazy from the other stuff and
  25. generally tried to write elegant and readable code while writing FAST.
  26.  
  27. People with a hang to monolitic assembler sources or a distaste for linkers
  28. will be pleased by what they'll find in the directory with the sources of
  29. xpkHUFF.library.
  30.  
  31. xpkmaster contains the cleanedup sources of the xpkmaster.library, but still
  32. is a mess. Do not try to understand the inner workings of xpkmaster.library
  33. without first having read all the documentation. Do not think after reading
  34. the docs you understand them. :-)
  35.  
  36. The SDI includes are replacements of standard ANSI functions. These includes
  37. mostly reduce the size of the executable, but they are not fully compatible
  38. to the ANSI C ones. You may use them or replace the include line with
  39. <stdlib>, <stdio.h> and <string.h>.
  40. The SDI defines define things I often use (f.e. CTRL_C and the version
  41. string).
  42.  
  43. About Pragma/Pragmas/Proto: SAS-C uses an directory <proto> to call system
  44. functions (together with <pragmas> directory). Because I use SAS and
  45. Maxon I tried to unify the different calling mechanisms. So I use everytime
  46. the <pragma> directory and define the librarybases in code. If you use
  47. standard SAS includes, you have to change the include lines in the sources.
  48.  
  49. For those, who want to code their own sublibrary:
  50. --------------------------------------------------
  51.  
  52. How has the version string to look?
  53. --> see how the standard or the example libraries handle this:
  54.  
  55. xpk<name of library> <version>.<revision> (<date>) <comments>\r\n\0
  56.  
  57. example: "xpkFAST 1.7 (07.09.96)\r\n\0"
  58.  
  59. (NOTE: \r = 0x13; \n = 0x10)
  60.  
  61. You do not need to add a "$VER: " somewhere in the text and the library
  62. name should be without ".library"! Also the date-format should be the above
  63. form, because Commodore defined this form as an nearly standard. Please
  64. make the work and include an correct library header, because this makes
  65. updating a lot easier! This means also a correct initialisation of the
  66. corresponding fields in the Resident (RomTag) structure. An example library
  67. header handling this you find in the xpk_Develop archive in the ASM-include
  68. directory. (If you have problems in doing this, contact me! - Dirk Stöcker)
  69.  
  70. How to compile the libraries with SAS-C:
  71. ----------------------------------------
  72.  
  73. Note: SAS-C assembler may report some errors in the asm files. This seems
  74. to be an bug in this assembler.
  75.  
  76.   xpkmaster.library:
  77.     call smake in the directory (You may have to change the assembler line
  78.     to your assembler before doing this!)
  79.     copy the library to LIBS:
  80.   other libraries:
  81.     run the assembler over the needed asm-file to get either the library or
  82.     an object file for the C-Compiler
  83.     if there is a SCOPTIONS file:
  84.       run sc without options in the directory of the library
  85.     copy the library to LIBS:
  86.   examples or shell programs
  87.     run smake in the directory
  88.  
  89. How to compile with Maxon C++ V3:
  90.  
  91.   xpkmaster.library:
  92.     use the makefile with Maxon's Make
  93.   shell programs:
  94.     run the compiler over the files (large data mode)
  95.                         Dirk and Christian.
  96.